# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
#
# Copyright (C) 2016-2017 Canonical Ltd
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3 as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

import snapcraft_legacy.extractors
from snapcraft_legacy.internal.states._state import PartState


class StageState(PartState):
    yaml_tag = "!StageState"

    def __init__(
        self,
        files,
        directories,
        part_properties=None,
        project=None,
        scriptlet_metadata=None,
    ):
        super().__init__(part_properties, project)

        if not scriptlet_metadata:
            scriptlet_metadata = snapcraft_legacy.extractors.ExtractedMetadata()

        self.files = files
        self.directories = directories
        self.scriptlet_metadata = scriptlet_metadata

    def properties_of_interest(self, part_properties):
        """Extract the properties concerning this step from part_properties.

        The only property of interest to the stage step is the `stage` keyword
        used to filter out files with a white or blacklist.
        """

        return {
            "filesets": part_properties.get("filesets", {}) or {},
            "override-stage": part_properties.get("override-stage"),
            "stage": part_properties.get("stage", ["*"]) or ["*"],
        }

    def project_options_of_interest(self, project):
        """Extract the options concerning this step from the project.

        The stage step doesn't care about any project options.
        """

        return {}
